Introduction
Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Authentication
To authorize, use this code:
require 'Kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn
api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
Make sure to replace
meowmeowmeowwith your API key.
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.
Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: meowmeowmeow
Accounts
The accounts object
Attributes:
Attribute
Type
Description
subdocument
Contains all the billing settings, like how is the billing going to happen, what happens with late checkouts and others
subdocument
Contains all information on employee candidates, like stage, description, hr information and more
subdocument
Contains all the payroll settings, like the type of payroll, the period and others
subdocuments
Contains information about the roles, like for example the type, color and all the permissions
subdocuments
Contains information on the sales reps, like his or hers name, office, nickname and others
subdocument
Contains all the scheduler settings, like duration and permissions for example
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
subdocument
Contains settings like the timezone, currency used, country, language and others
subdocument
Contains the telephony information, like the authentication token, errors and others
subdocument
Contains all the visit settings, like punchcards, gps, overrides and telephony
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Candidates
The candidates object
Attributes:
Attribute
Type
Description
subdocument
What are the days and hours that the candidate is available during the week
id
What is the status of the candidate, applied, phone screened, selected for interview, interviewd or hired
id
Contains information on the candidate's drivers licence, if the candidate has one or not and others
subdocuments
This contains the employment history of the candidate, previous jobs, duration and etc
subdocument
Information on which range of ages the candidate has experience with
subdocuments
Contains the languages spoken by the candidate and which one is the primary language
id
Contains the method of transportation of the candidate, if it is by bus or car for example
subdocument
Contains information on the candidate work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Clients
The clients object
Attributes:
Attribute
Type
Description
subdocuments
Contains information on the employees, like their names, offices, emails and others
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Contacts
The contacts object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Conversations
The conversations object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Events
The events object
Attributes:
Attribute
Type
Description
subdocuments
Information on who are the attendees on the event, like name, pay_rate and others
subdocument
Information on the billing, like billing period, currency, payment method and others
subdocument
Location where the event is going to start with information like address and geolocation
subdocument
Location where the event is going to end with information like address and geolocation
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Eventsgroups
The eventsgroups object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Files
The files object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Invoices
The invoices object
Attributes:
Attribute
Type
Description
subdocument
Contains information on the sales rep, like his or hers name, office, nickname and others
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patients
The patients object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patientsprogressnotes
The patientsprogressnotes object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payments
The payments object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrolls
The payrolls object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrollsusers
The payrollsusers object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Punchcards
The punchcards object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Skills
The skills object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Tags
The tags object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Users
The users object
Attributes:
Attribute
Type
Description
id
Contains information on the user's drivers licence, if the user has one or not and others
subdocuments
This contains the employment history of the user, previous jobs, duration and etc
subdocuments
Languages spoken by the user, with information on which one is his or hers primary language
id
Contains the method of transportation of the user, if it is by bus or car for example
subdocument
Contains information on the user work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Usersnotes
The usersnotes object
Attributes:
Attribute
Type
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'